Skip to main content
GET
Get an agent billing plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

plan_id
string
required

Response

id
string
required

Unique Hyperline identifier for this resource.

Example:

"d18603dd-7285-4bf5-a45e-88d7de8f37c9"

name
string
required

Human-readable resource name.

Example:

"Support agent plan"

mode
enum<string>
required

Billing mode.

  • wallet: Charges a monetary wallet.
  • credits: Consumes a credit balance.
  • windows: Meters weighted units against rolling allowances.
Available options:
wallet,
credits,
windows
Example:

"wallet"

rate_card
object | null
required

Public rate card used by this plan, or null when the plan supplies none.

Example:

null

windows
object[]
required

Rolling allowances. Required for windows plans; each window meters every call. A plan replacement replaces the entire array.

Example:
markup_percent
string | null
required

Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"20"

overage_mode
enum<string>
required

Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.

  • refuse: Rejects the call that crosses the boundary without deducting usage.
  • metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.
Available options:
refuse,
metered
Example:

"metered"

overage_markup_percent
string | null
required

Percentage added to provider cost for overage. Mutually exclusive with overage_rate_card_id.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"10"

overage_rate_card_id
string | null
required

Currency rate card used to price overage directly. Null means provider cost plus the resolved overage markup.

Example:

"airc_overage"

settlement_interval_minutes
number | null
required

Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.

Example:

60

settlement_schedule
enum<string> | null
required

Calendar settlement schedule. Null clears the override; mutually exclusive with settlement_interval_minutes.

  • calendar_month: Settles at the end of each UTC calendar month.
Available options:
calendar_month
Example:

"calendar_month"

per_seat_credits
string | null
required

Credits granted per seat per billing period. Null grants no credits.

Pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
Example:

"10000"

grant_rollover_enabled
boolean
required

Whether granted credits survive renewal. Purchased credits always roll over.

Example:

true

billing_item_ids
string[]
required

Public product identifiers for this plan's invoice charges, in creation order. Read-only; amounts are defined by the corresponding price configurations.

Example:
price_configuration_ids
string[]
required

Public price configuration identifiers corresponding to billing_item_ids. Read-only.

Example:
using_policy_count
number
required

Number of customer policy scopes referencing this resource.

Example:

1

is_default
boolean
required

Whether this is the default plan or shared customer scope.

Example:

false